lteiot16.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef LTEIOT16_H
#define LTEIOT16_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"




#define LTEIOT16_CMD_AT                             "AT"
#define LTEIOT16_CMD_GET_MODEL_ID                   "AT+CGMM"
#define LTEIOT16_CMD_GET_SW_VERSION                 "AT+CGMR"
#define LTEIOT16_CMD_GET_SERIAL_NUM                 "AT+CGSN"
#define LTEIOT16_CMD_FACTORY_RESET                  "AT&F"
#define LTEIOT16_CMD_SET_MODULE_FUNCTIONALITY       "AT+CFUN"
#define LTEIOT16_CMD_EPS_NETWORK_REGISTRATION       "AT+CEREG"
#define LTEIOT16_CMD_SIGNAL_QUALITY_REPORT          "AT+CSQ"
#define LTEIOT16_CMD_OPERATOR_SELECTION             "AT+COPS"
#define LTEIOT16_CMD_SEND_SMS                       "AT+CMGS"
#define LTEIOT16_CMD_SELECT_SMS_FORMAT              "AT+CMGF"
#define LTEIOT16_CMD_DEFINE_PDP_CONTEXT             "AT+CGDCONT"
#define LTEIOT16_CMD_SHOW_PDP_ADDRESS               "AT+CGPADDR"
#define LTEIOT16_CMD_ACTIVATE_PDP_CONTEXT           "AT+CGACT"
#define LTEIOT16_CMD_PSD_CONFIG                     "AT+UPSD"
#define LTEIOT16_CMD_PSD_ACTION                     "AT+UPSDA"
#define LTEIOT16_CMD_CREATE_SOCKET                  "AT+USOCR"
#define LTEIOT16_CMD_CLOSE_SOCKET                   "AT+USOCL"
#define LTEIOT16_CMD_CONNECT_SOCKET                 "AT+USOCO"
#define LTEIOT16_CMD_WRITE_SOCKET_DATA              "AT+USOWR"
#define LTEIOT16_CMD_READ_SOCKET_DATA               "AT+USORD"
#define LTEIOT16_CMD_GPIO_CONFIG                    "AT+UGPIOC"
#define LTEIOT16_CMD_GNSS_POWER_MANAGEMENT          "AT+UGPS"
#define LTEIOT16_CMD_GET_GNSS_FIX_DATA              "AT+UGGGA"

#define LTEIOT16_RSP_OK                             "OK"
#define LTEIOT16_RSP_ERROR                          "ERROR"

#define LTEIOT16_URC_CREATE_SOCKET                  "+USOCR: "
#define LTEIOT16_URC_RECEIVED_DATA                  "+UUSORD: "

#define LTEIOT16_POWER_STATE_OFF                    0
#define LTEIOT16_POWER_STATE_ON                     1
#define LTEIOT16_POWER_STATE_RESET                  2

#define LTEIOT16_RSP_START                          "$"
#define LTEIOT16_RSP_DELIMITER                      ","
#define LTEIOT16_RSP_END                            "\r\n"
#define LTEIOT16_RSP_GGA                            "GGA"

#define LTEIOT16_GGA_ELEMENT_SIZE                   15
#define LTEIOT16_GGA_TIME                           1
#define LTEIOT16_GGA_LATITUDE                       2
#define LTEIOT16_GGA_LATITUDE_SIDE                  3
#define LTEIOT16_GGA_LONGITUDE                      4
#define LTEIOT16_GGA_LONGITUDE_SIDE                 5
#define LTEIOT16_GGA_QUALITY_INDICATOR              6
#define LTEIOT16_GGA_NUMBER_OF_SATELLITES           7
#define LTEIOT16_GGA_H_DILUTION_OF_POS              8
#define LTEIOT16_GGA_ALTITUDE                       9
#define LTEIOT16_GGA_ALTITUDE_UNIT                  10
#define LTEIOT16_GGA_GEOIDAL_SEPARATION             11
#define LTEIOT16_GGA_GEOIDAL_SEPARATION_UNIT        12
#define LTEIOT16_GGA_TIME_SINCE_LAST_DGPS           13
#define LTEIOT16_GGA_DGPS_REFERENCE_STATION_ID      14

#define LTEIOT16_TX_DRV_BUFFER_SIZE                 300
#define LTEIOT16_RX_DRV_BUFFER_SIZE                 300
 // lteiot16_cmd



#define LTEIOT16_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.ring = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
 // lteiot16_map // lteiot16

typedef struct
{
    // Output pins
    digital_out_t pwr;              
    digital_out_t rst;              
    digital_out_t rts;              
 
    // Input pins
    digital_in_t ring;              
    digital_in_t cts;               
 
    // Modules
    uart_t uart;                    
 
    // Buffers
    uint8_t uart_rx_buffer[ LTEIOT16_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ LTEIOT16_TX_DRV_BUFFER_SIZE ];  
    uint8_t cmd_buffer[ LTEIOT16_TX_DRV_BUFFER_SIZE ];      
 
} lteiot16_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;              
    pin_name_t tx_pin;              
 
    // Additional gpio pins
    pin_name_t pwr;                 
    pin_name_t rst;                 
    pin_name_t rts;                 
    pin_name_t ring;                
    pin_name_t cts;                 
 
    // Static variable
    uint32_t         baud_rate;     
    bool             uart_blocking; 
    uart_data_bits_t data_bit;      
    uart_parity_t    parity_bit;    
    uart_stop_bits_t stop_bit;      
 
} lteiot16_cfg_t;

typedef enum
{
    LTEIOT16_OK = 0,
    LTEIOT16_ERROR = -1,
    LTEIOT16_ERROR_TIMEOUT = -2,
    LTEIOT16_ERROR_CMD = -3
 
} lteiot16_return_value_t;


void lteiot16_cfg_setup ( lteiot16_cfg_t *cfg );

err_t lteiot16_init ( lteiot16_t *ctx, lteiot16_cfg_t *cfg );

err_t lteiot16_generic_write ( lteiot16_t *ctx, uint8_t *data_in, uint16_t len );

err_t lteiot16_generic_read ( lteiot16_t *ctx, uint8_t *data_out, uint16_t len );
 

void lteiot16_set_pwr_pin ( lteiot16_t *ctx, uint8_t state );

void lteiot16_set_rst_pin ( lteiot16_t *ctx, uint8_t state );

void lteiot16_set_rts_pin ( lteiot16_t *ctx, uint8_t state );

uint8_t lteiot16_get_ring_pin ( lteiot16_t *ctx );

uint8_t lteiot16_get_cts_pin ( lteiot16_t *ctx );

void lteiot16_set_power_state ( lteiot16_t *ctx, uint8_t state );

void lteiot16_cmd_run ( lteiot16_t *ctx, uint8_t *cmd );

void lteiot16_cmd_set ( lteiot16_t *ctx, uint8_t *cmd, uint8_t *value );

void lteiot16_cmd_get ( lteiot16_t *ctx, uint8_t *cmd );

void lteiot16_cmd_help ( lteiot16_t *ctx, uint8_t *cmd );

void lteiot16_set_sim_apn ( lteiot16_t *ctx, uint8_t *sim_apn );

void lteiot16_send_sms_text ( lteiot16_t *ctx, uint8_t *phone_number, uint8_t *sms_text );

err_t lteiot16_send_sms_pdu ( lteiot16_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );

err_t lteiot16_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );
 
#ifdef __cplusplus
}
#endif
#endif // LTEIOT16_H
 // lteiot16
 
// ------------------------------------------------------------------------ END